FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.medmorph#current (63 ms)

Package hl7.fhir.us.medmorph
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/medmorph/https://build.fhir.org/ig/HL7/fhir-medmorph/CapabilityStatement-medmorph-data-receiver.html
Url http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver
Version 1.0.0
Status draft
Date 2020-12-06
Name DataReceiver
Title Example Data Receiver Capability Statement
Experimental False
Realm us
Authority hl7
Description This example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG. The actor is responsible for defining Knowledge Artifacts, receiving reports, and submitting responses back to health care organizations. The specific knowlege artifacts, reports and responses to be supported by the Data Receiver will be defined by the Content IGs.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
us-ph-plandefinition US Public Health PlanDefinition


Narrative

Note: links and images are rebased to the (stated) source

DataReceiver

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver

Published by: HL7 International - Public Health Work Group

This example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG. The actor is responsible for defining Knowledge Artifacts, receiving public health reports, and submitting responses back to health care organizations. The specific knowledge artifacts, reports, and responses supported by the Data Receiver will be defined by the content IGs.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the Data Receiver is to define Knowledge Artifacts, receive reports and submit responses back to clinical care organizations.

Security:

Implementations must meet the general security requirements documented in FHIR Security guidance.

In addition the Data Receiver needs to meet the security requirements as outlined in the Formal Specification - Security Section.

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete
PlanDefinition (Profile) SHALL SHALL SHOULD SHALL SHALL

FHIR Operations summary

The following FHIR operations SHALL be supported by the Data Receiver.



PlanDefinition

Profile: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition

Interactions

Name Description
  search-type

Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.

  read

Allows retrieval of a specific PlanDefinition instance.

  vread

Allows retrieval of a historical version of a PlanDefinition instance.

  create

Allows creation of PlanDefinition instances

  update

Allows Update of PlanDefinition instances



Search

Parameter Type Definition & Chaining
identifier token Search using identifiers as allowed according to the FHIR specification.
name string Search using PlanDefinition name.
publisher string Search using publisher name.
title string Search using title.
version string Search using version.
name and version string, string Search using name and version.



Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "medmorph-data-receiver",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>DataReceiver</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver</p>\n <p>Published by: <b>HL7 International - Public Health Work Group</b>\n </p>\n <p>This example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG. The actor is responsible for defining Knowledge Artifacts, receiving public health reports, and submitting responses back to health care organizations. The specific knowledge artifacts, reports, and responses supported by the Data Receiver will be defined by the content IGs.</p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table>\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST behavior</h2>\n <p>The primary focus of the Data Receiver is to define Knowledge Artifacts, receive reports and submit responses back to clinical care organizations.</p>\n <p>\n <b>Security:</b>\n </p>\n <p>Implementations must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>In addition the Data Receiver needs to meet the security requirements as outlined in the <a href=\"spec.html#authentication-and-authorization-requirements\">Formal Specification - Security Section.</a></p>\n <h3>Resource summary</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>PlanDefinition (<a href=\"StructureDefinition-us-ph-plandefinition.html\">Profile</a>)</th>\n <td>\n <a href=\"#PlanDefinition-search-type\" title=\"Allows a user to search for existing PlanDefinition instances\">SHALL</a>\n </td>\n <td>\n <a href=\"#PlanDefinition-read\" title=\"Allows retrieval of a specific PlanDefinition Resource instance \">SHALL</a>\n </td>\n <td>\n <a href=\"#PlanDefinition-vread\" title=\"Allows retrieval of a specific PlanDefinition Resource instance version\">SHOULD</a>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#PlanDefinition-create\" title=\"Allows creation of a specific PlanDefinition Resource instance\">SHALL</a>\n </td>\n <td>\n <a href=\"#PlanDefinition-update\" title=\"Allows update of a specific PlanDefinition Resource instance\">SHALL</a>\n </td>\n <td/>\n </tr>\n </tbody>\n </table>\n </div>\n \n <h3>FHIR Operations summary</h3>\n <p>The following FHIR operations SHALL be supported by the Data Receiver.</p>\n \n <ul>\n <li>\n <a href=\"https://www.hl7.org/fhir/messageheader-operation-process-message.html\">Bundle process-message</a>\n <p>An example implementation of the process-message operation can be found at <a href=\"https://github.com/drajer-health/ecr-on-fhir/tree/master/fhir-eicr-r4\">Example process-message operation using HAPI</a></p>\n </li>\n </ul>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/plandefinition.html\">PlanDefinition</a>\n </h3>\n <p>Profile: <a href=\"StructureDefinition-us-ph-plandefinition.html\">http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"PlanDefinition-search-type\">�</a>\n <span>search-type</span>\n </th>\n <td>\n <p>Allows discovery of existing PlanDefinition instances representing Knowledge Artifacts.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"PlanDefinition-read\">�</a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific PlanDefinition instance.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"PlanDefinition-vread\">�</a>\n <span>vread</span>\n </th>\n <td>\n <p>Allows retrieval of a historical version of a PlanDefinition instance.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"PlanDefinition-create\">�</a>\n <span>create</span>\n </th>\n <td>\n <p>Allows creation of PlanDefinition instances</p>\n </td>\n </tr> \n <tr>\n <th>\n <a name=\"PlanDefinition-update\">�</a>\n <span>update</span>\n </th>\n <td>\n <p>Allows Update of PlanDefinition instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h4>Search</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th>\n <th>Definition &amp; Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>identifier</th>\n <td>token</td>\n <td>Search using identifiers as allowed according to the FHIR specification.</td>\n </tr>\n <tr>\n <th>name</th>\n <td>string</td>\n <td>Search using PlanDefinition name.</td>\n </tr>\n <tr>\n <th>publisher</th>\n <td>string</td>\n <td>Search using publisher name.</td>\n </tr>\n <tr>\n <th>title</th>\n <td>string</td>\n <td>Search using title.</td>\n </tr>\n <tr>\n <th>version</th>\n <td>string</td>\n <td>Search using version.</td>\n </tr>\n <tr>\n <th>name and version</th>\n <td>string, string</td>\n <td>Search using name and version.</td>\n </tr>\n </tbody>\n </table>\n </div> \n <br/>\n <br/> \n </div>"
  },
  "url" : "http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-data-receiver",
  "version" : "1.0.0",
  "name" : "DataReceiver",
  "title" : "Example Data Receiver Capability Statement",
  "status" : "draft",
  "date" : "2020-12-06",
  "publisher" : "HL7 International - Public Health Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "This example CapabilityStatement defines the expected capabilities of the Data Receiver actor when conforming to the MedMorph RA IG. The actor is responsible for defining Knowledge Artifacts, receiving reports, and submitting responses back to health care organizations. The specific knowlege artifacts, reports and responses to be supported by the Data Receiver will be defined by the Content IGs.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "The focus of the Data Receiver is to for define Knowledge Artifacts, receive reports and submit responses back to clinical care organizations. ",
      "security" : {
        "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "resource" : [
        {
          "type" : "PlanDefinition",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing PlanDefinition instances."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific PlanDefinition instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a PlanDefinition instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "create",
              "documentation" : "Allows creation of a PlanDefinition resource instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "update",
              "documentation" : "Allows update of a PlanDefinition resource instance."
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "publisher",
              "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "title",
              "definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
              "type" : "string"
            }
          ]
        }
      ],
      "operation" : [
        {
          "name" : "process-message",
          "definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
        }
      ]
    },
    {
      "mode" : "server",
      "documentation" : "The focus of the Data Receiver as a Server is to expose $process-message endpoint at the root of the FHIR server.",
      "security" : {
        "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "operation" : [
        {
          "name" : "process-message",
          "definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.